docs(AGENTS): tool credentials live in $HOME, never in project tree - #46
Merged
Conversation
…t tree" Make the convention every existing framework tool already follows (Gmail OAuth at ~/.config/apache-steward/gmail-oauth.json, PonyMail session cookie at ~/.ponymail-mcp/session.json, GitHub auth via gh auth → ~/.config/gh/) explicit in AGENTS.md so future tool integrations follow the same pattern. Two reasons it's non-negotiable: (1) the standard sandbox denies reads on home-dir credential paths, so an in-tree credential silently bypasses that boundary — every credential read should be an explicit, visible sandbox-bypass moment, not a silent in-tree file slurp; (2) one credential file should serve every clone / worktree / project, not be re-acquired per checkout. Generated-by: Claude Code (Claude Opus 4.7)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Codify the credential-storage convention every existing framework tool already follows, so future tool integrations follow the same pattern.
~/.config/apache-steward/gmail-oauth.json~/.ponymail-mcp/session.jsongh auth(~/.config/gh/)Two reasons it's non-negotiable:
docs/setup/secure-agent-setup.md) denies reads on home-dir credential paths. An in-tree credential silently bypasses that boundary — every credential read should be an explicit, visible sandbox-bypass moment, not a silent in-tree file slurp.The new principle slots in as a sibling to the existing "Run the agent in the credential-isolation setup" block under
## Local setup.Test plan
tools/gmail/oauth-draft/src/oauth_draft/credentials.py,tools/ponymail/,tools/github/) already follow the rule.